/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.context.properties.bind;

import org.springframework.boot.context.properties.source.ConfigurationProperty;
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;

/**
 * 提供给 {@link BindHandler BindHandlers} 使用的上下文信息。
 *
 * @author Phillip Webb
 * @author Madhura Bhave
 * @since 2.0.0
 */
public interface BindContext {

	/**
	 * 返回执行绑定操作的源 Binder。
	 * @return 源 Binder
	 */
	Binder getBinder();

	/**
	 * 返回当前绑定的深度。根绑定的深度从 {@code 0} 开始。
	 * 每绑定一个子属性，深度增加 {@code 1}。
	 * @return 当前绑定的深度
	 */
	int getDepth();

	/**
	 * 返回 {@link Binder} 正在使用的 {@link ConfigurationPropertySource} 源的 {@link Iterable} 集合。
	 * @return 配置属性源集合
	 */
	Iterable<ConfigurationPropertySource> getSources();

	/**
	 * 返回当前实际被绑定的 {@link ConfigurationProperty}，如果属性尚未确定，则返回 {@code null}。
	 * @return 配置属性（可能为 {@code null}）
	 */
	ConfigurationProperty getConfigurationProperty();

}
